Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Full review of files in beats/journalbeat/docs #1

Merged
merged 4 commits into from
Nov 8, 2018

Conversation

dedemorton
Copy link
Owner

@dedemorton dedemorton commented Nov 1, 2018

This PR contains all files added to /beats/journalbeat/docs for 6.5. It does not include files from beats/libbeat/docs. The beats-docs-review repository is intended for review purposes only. You will not be able to build/test the files in this repo.

Please review the proposed additions and add your comments to this PR. After we're through reviewing/updating the files in /beats/journalbeat/docs, you'll have an opportunity to do a final review of all the files (including the files from libbeat) in the Beats repo.

You can preview the docs here: https://journalbeat-62556.firebaseapp.com/index.html

Here's a list of open issues that you can help me resolve. Please identify anything else that is missing:

  • Verify package names in the installation topic (they were missing from BC1).
  • Check to see if apt/yum repos will be available. If not, remove the note.
  • Verify that seek: cursor is the default.
  • Determine whether we want to recommend using sudo in the install topic.
  • Defer: Improve descriptions of backoff_factor and and max_backoff. Looked at the descritpions for Filebeat, but TBH I couldn't follow them very well.

Note that I plan to do the following work in separate PRs:

  • Update the command reference (I'm also updating it for Functionbeat)
  • Add linux command examples to the shared files.

When this review is closed, go to elastic/beats#8864 to complete the final review.

@kvch
Copy link

kvch commented Nov 5, 2018

Regarding your third point, right now tail is the default value for seek. I am sorry if I indicated somewhere else otherwise. However, setting cursor would be a saner choice. I am opening a PR to change it.

@urso
Copy link

urso commented Nov 5, 2018

Verify package names in the installation topic (they were missing from BC1).

package names seem fine. journalbeat is included in BC2

Determine whether we want to recommend using sudo in the install topic.

The beat is installed as root by default -> sudo is required.

We also use sudo in docs of the other beats. Let's keep it for consistency.

@kvch
Copy link

kvch commented Nov 8, 2018

FYI I fix the issues we have discussed in this PR: elastic/beats#8973

[[view-kibana-dashboards]]
=== Step 5: View your data in Kibana

There are currently no example dashboards available for {beatname_uc}.
Copy link

@kvch kvch Nov 8, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have added one. You can find it in the PR I linked.

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kvch I'm assuming that there are no dashboards for 6.5 though, correct? I want to get the 6.5 version of the docs finalized.

@dedemorton dedemorton merged commit 528226f into master Nov 8, 2018
@dedemorton
Copy link
Owner Author

Merged review to close out. Please add any additional comments to the PR here: elastic/beats#8864

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants